<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EasyXPlus: EasyXPlus::Bitmap Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">EasyXPlus
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">EasyXPlus is a simple graphic library for C++ BEGINNERS under Windows.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>EasyXPlus</b></li><li class="navelem"><a class="el" href="class_easy_x_plus_1_1_bitmap.html">Bitmap</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_easy_x_plus_1_1_bitmap-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">EasyXPlus::Bitmap Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A bitmap class.  
 <a href="class_easy_x_plus_1_1_bitmap.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="easy_bitmap_8h_source.html">easyBitmap.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a730d52870cea87f48d7aa79bbcc24183"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_easy_x_plus_1_1_bitmap.html#a730d52870cea87f48d7aa79bbcc24183">Bitmap</a> (std::wstring bitmapFilename)</td></tr>
<tr class="memdesc:a730d52870cea87f48d7aa79bbcc24183"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a bitmap from the given filename.  <a href="#a730d52870cea87f48d7aa79bbcc24183">More...</a><br /></td></tr>
<tr class="separator:a730d52870cea87f48d7aa79bbcc24183"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr class="memitem:a366ec6d09e3846f7e84dd8672e8f8613"><td class="memItemLeft" align="right" valign="top"><a id="a366ec6d09e3846f7e84dd8672e8f8613"></a>
unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_easy_x_plus_1_1_bitmap.html#a366ec6d09e3846f7e84dd8672e8f8613">getWidth</a> () const</td></tr>
<tr class="memdesc:a366ec6d09e3846f7e84dd8672e8f8613"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get bitmap width in pixel unit. <br /></td></tr>
<tr class="separator:a366ec6d09e3846f7e84dd8672e8f8613"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79b977d19be38c69e101cfc30c3cbf9e"><td class="memItemLeft" align="right" valign="top"><a id="a79b977d19be38c69e101cfc30c3cbf9e"></a>
unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_easy_x_plus_1_1_bitmap.html#a79b977d19be38c69e101cfc30c3cbf9e">getHeight</a> () const</td></tr>
<tr class="memdesc:a79b977d19be38c69e101cfc30c3cbf9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get bitmap height in pixel unit. <br /></td></tr>
<tr class="separator:a79b977d19be38c69e101cfc30c3cbf9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr class="memitem:ad1bb3d00559fe1de361990fa923d6a7a"><td class="memItemLeft" align="right" valign="top"><a id="ad1bb3d00559fe1de361990fa923d6a7a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_easy_x_plus_1_1_bitmap.html#ad1bb3d00559fe1de361990fa923d6a7a">verticalFlip</a> ()</td></tr>
<tr class="memdesc:ad1bb3d00559fe1de361990fa923d6a7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flip the bitmap vertically. <br /></td></tr>
<tr class="separator:ad1bb3d00559fe1de361990fa923d6a7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fc65a423a60bd4357b5c893e68fcbcf"><td class="memItemLeft" align="right" valign="top"><a id="a6fc65a423a60bd4357b5c893e68fcbcf"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_easy_x_plus_1_1_bitmap.html#a6fc65a423a60bd4357b5c893e68fcbcf">horizontalFlip</a> ()</td></tr>
<tr class="memdesc:a6fc65a423a60bd4357b5c893e68fcbcf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flip the bitmap horizontally. <br /></td></tr>
<tr class="separator:a6fc65a423a60bd4357b5c893e68fcbcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae42b35c824cad539e8e44d4d0b317e75"><td class="memItemLeft" align="right" valign="top"><a id="ae42b35c824cad539e8e44d4d0b317e75"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_easy_x_plus_1_1_bitmap.html#ae42b35c824cad539e8e44d4d0b317e75">resetFlip</a> ()</td></tr>
<tr class="memdesc:ae42b35c824cad539e8e44d4d0b317e75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset(clear) all flip actions. <br /></td></tr>
<tr class="separator:ae42b35c824cad539e8e44d4d0b317e75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr class="memitem:a42573564363fe8b621210c18d9a1d0b4"><td class="memItemLeft" align="right" valign="top"><a id="a42573564363fe8b621210c18d9a1d0b4"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_easy_x_plus_1_1_bitmap.html#a42573564363fe8b621210c18d9a1d0b4">draw</a> (const <a class="el" href="class_easy_x_plus_1_1_rect_region.html">RectRegion</a> &amp;region)</td></tr>
<tr class="memdesc:a42573564363fe8b621210c18d9a1d0b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Draw the bitmap in the given region. <br /></td></tr>
<tr class="separator:a42573564363fe8b621210c18d9a1d0b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8045ee0a459625c75ad4703d2b9c9b8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_easy_x_plus_1_1_bitmap.html#aa8045ee0a459625c75ad4703d2b9c9b8">draw</a> (const <a class="el" href="class_easy_x_plus_1_1_point.html">Point</a> &amp;leftTop, const <a class="el" href="class_easy_x_plus_1_1_rect.html">Rect</a> &amp;rect)</td></tr>
<tr class="memdesc:aa8045ee0a459625c75ad4703d2b9c9b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Draw the bitmap with the given left-top point and rectangle.  <a href="#aa8045ee0a459625c75ad4703d2b9c9b8">More...</a><br /></td></tr>
<tr class="separator:aa8045ee0a459625c75ad4703d2b9c9b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa242bd8e8b712120f51ee85d69f1ab28"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_easy_x_plus_1_1_bitmap.html#aa242bd8e8b712120f51ee85d69f1ab28">draw</a> (const <a class="el" href="class_easy_x_plus_1_1_point.html">Point</a> &amp;leftTop, int width, int height)</td></tr>
<tr class="memdesc:aa242bd8e8b712120f51ee85d69f1ab28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Draw the bitmap with the given left-top point, width and height.  <a href="#aa242bd8e8b712120f51ee85d69f1ab28">More...</a><br /></td></tr>
<tr class="separator:aa242bd8e8b712120f51ee85d69f1ab28"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A bitmap class. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a730d52870cea87f48d7aa79bbcc24183"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a730d52870cea87f48d7aa79bbcc24183">&#9670;&nbsp;</a></span>Bitmap()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">EasyXPlus::Bitmap::Bitmap </td>
          <td>(</td>
          <td class="paramtype">std::wstring&#160;</td>
          <td class="paramname"><em>bitmapFilename</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Creates a bitmap from the given filename. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname"><a class="el" href="class_easy_x_plus_1_1_easy_except.html" title="The exception type used by EasyXPlus library. ">EasyExcept</a></td><td>If an error occurs, it throws an exception. The error is most probably caused by a invalid bitmap filename. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa8045ee0a459625c75ad4703d2b9c9b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8045ee0a459625c75ad4703d2b9c9b8">&#9670;&nbsp;</a></span>draw() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void EasyXPlus::Bitmap::draw </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_easy_x_plus_1_1_point.html">Point</a> &amp;&#160;</td>
          <td class="paramname"><em>leftTop</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="class_easy_x_plus_1_1_rect.html">Rect</a> &amp;&#160;</td>
          <td class="paramname"><em>rect</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Draw the bitmap with the given left-top point and rectangle. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">leftTop</td><td>The left-top point from which the bitmap starts to be drawn. </td></tr>
    <tr><td class="paramname">rect</td><td>A rectangle which points out the size of the drawing size(width and height). </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="aa242bd8e8b712120f51ee85d69f1ab28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa242bd8e8b712120f51ee85d69f1ab28">&#9670;&nbsp;</a></span>draw() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void EasyXPlus::Bitmap::draw </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_easy_x_plus_1_1_point.html">Point</a> &amp;&#160;</td>
          <td class="paramname"><em>leftTop</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>width</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>height</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Draw the bitmap with the given left-top point, width and height. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">leftTop</td><td>The left-top point from which the bitmap starts to be drawn. </td></tr>
    <tr><td class="paramname">width</td><td>A positive width with which the bitmap is to be drawn. </td></tr>
    <tr><td class="paramname">height</td><td>A positive height with which the bitmap is to be drawn. </td></tr>
  </table>
  </dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname"><a class="el" href="class_easy_x_plus_1_1_easy_except.html" title="The exception type used by EasyXPlus library. ">EasyExcept</a></td><td>If width or height passed is negative, it throws an exception. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="easy_bitmap_8h_source.html">easyBitmap.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
